SureTax DRC API
Get Generation Request Status
Overview
This API endpoint is utilized to continuously check the status of form generation requests until the process reaches its final completion status. It enables clients to monitor the progress of form generation activities until they are successfully completed or terminated.
OperationId: Get Generation Request Status
Authorization Method(s): OAuth
Verb: GET
End Point: /api/Forms/GenerationRequestStatus
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Id* | Id | string |
Overview
Response object containing the status of a generation request and details about the form instances.
Example Response
The following is an example response you can expect for this operation
{
"data": {
"requestStatus": "Completed",
"formInstances": [
{
"id": "0000011111",
"formId": "FORM12345",
"reportingPeriodFromDate": "2023-01-01",
"reportingPeriodToDate": "2023-03-31",
"reportingPeriodicity": "Quarterly",
"reportingPeriodNum": "Q1",
"reportingPhase": "Initial",
"reportingPhaseIndex": "1",
"locationId": "LOC123",
"status": "Generated",
"generatedOn": "2023-04-01T12:00:00Z"
}
],
"externalReportingEntity": "EXT12345"
}
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains the status of the generation request and details of the form instances. Success Response - 200 OK |
| 204 | 204 No Content If no records are found for the provided request, the API will respond with a No Content status. |
| 400 | Bad request. The API will respond with an error if there is an issue with the request parameters. |
| 401 | Unauthorized request. The API will respond with an error if the user is not authenticated. |
| 500 | Internal server error. The API will respond with an error if there is an unexpected server issue. |